org.springframework.mock.http.server.reactive

Class MockServerHttpRequest.DefaultBodyBuilder

java.lang.Object

org.springframework.mock.http.server.reactive.MockServerHttpRequest.DefaultBodyBuilder

All Implemented Interfaces:

MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>, MockServerHttpRequest.BodyBuilder

Enclosing class:

MockServerHttpRequest

private static class MockServerHttpRequest.DefaultBodyBuilder
extends java.lang.Object
implements MockServerHttpRequest.BodyBuilder

Field Summary

Fields

Modifier and Type	Field and Description
private static DataBufferFactory	BUFFER_FACTORY
private java.lang.String	contextPath
private MultiValueMap<java.lang.String,HttpCookie>	cookies
private HttpHeaders	headers
private HttpMethod	method
private UriComponentsBuilder	queryParamsBuilder
private java.net.InetSocketAddress	remoteAddress
private SslInfo	sslInfo
private java.net.URI	url

Constructor Summary

Constructors

Constructor and Description
DefaultBodyBuilder(HttpMethod method, java.net.URI url)

Method Summary

Modifier and Type	Method and Description
MockServerHttpRequest.BodyBuilder	accept(MediaType... acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
MockServerHttpRequest.BodyBuilder	acceptCharset(java.nio.charset.Charset... acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
MockServerHttpRequest.BodyBuilder	acceptLanguageAsLocales(java.util.Locale... acceptableLocales) Set the list of acceptable locales, as specified by the Accept-Languages header.
private void	applyCookiesIfNecessary()
MockServerHttpRequest	body(<any> body) Set the body of the request and build it.
MockServerHttpRequest	body(java.lang.String body) Set the body of the request and build it.
MockServerHttpRequest	build() Builds the request with no body.
MockServerHttpRequest.BodyBuilder	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
MockServerHttpRequest.BodyBuilder	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
MockServerHttpRequest.BodyBuilder	contextPath(java.lang.String contextPath) Set the contextPath to return.
MockServerHttpRequest.BodyBuilder	cookie(HttpCookie... cookies) Add one or more cookies.
MockServerHttpRequest.BodyBuilder	cookies(MultiValueMap<java.lang.String,HttpCookie> cookies) Add the given cookies.
private java.nio.charset.Charset	getCharset()
private java.net.URI	getUrlToUse()
MockServerHttpRequest.BodyBuilder	header(java.lang.String headerName, java.lang.String... headerValues) Add the given, single header value under the given name.
MockServerHttpRequest.BodyBuilder	headers(MultiValueMap<java.lang.String,java.lang.String> headers) Add the given header values.
MockServerHttpRequest.BodyBuilder	ifModifiedSince(long ifModifiedSince) Set the value of the If-Modified-Since header.
MockServerHttpRequest.BodyBuilder	ifNoneMatch(java.lang.String... ifNoneMatches) Set the values of the If-None-Match header.
MockServerHttpRequest.BodyBuilder	ifUnmodifiedSince(long ifUnmodifiedSince) Set the (new) value of the If-Unmodified-Since header.
MockServerHttpRequest.BodyBuilder	queryParam(java.lang.String name, java.lang.Object... values) Append the given query parameter to the existing query parameters.
MockServerHttpRequest.BodyBuilder	queryParams(MultiValueMap<java.lang.String,java.lang.String> params) Add the given query parameters and values.
MockServerHttpRequest.BodyBuilder	range(HttpRange... ranges) Set the (new) value of the Range header.
MockServerHttpRequest.BodyBuilder	remoteAddress(java.net.InetSocketAddress remoteAddress) Set the remote address to return.
void	sslInfo(SslInfo sslInfo) Set SSL session information and certificates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUFFER_FACTORY

private static final DataBufferFactory BUFFER_FACTORY

method

private final HttpMethod method

url

private final java.net.URI url

contextPath

@Nullable
private java.lang.String contextPath

queryParamsBuilder

private final UriComponentsBuilder queryParamsBuilder

headers

private final HttpHeaders headers

cookies

private final MultiValueMap<java.lang.String,HttpCookie> cookies

remoteAddress

@Nullable
private java.net.InetSocketAddress remoteAddress

sslInfo

@Nullable
private SslInfo sslInfo

Constructor Detail

DefaultBodyBuilder

public DefaultBodyBuilder(HttpMethod method,
                          java.net.URI url)

Method Detail

contextPath

public MockServerHttpRequest.BodyBuilder contextPath(java.lang.String contextPath)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the contextPath to return.

Specified by:

contextPath in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

queryParam

public MockServerHttpRequest.BodyBuilder queryParam(java.lang.String name,
                                                    java.lang.Object... values)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Append the given query parameter to the existing query parameters. If no values are given, the resulting URI will contain the query parameter name only (i.e. ?foo instead of ?foo=bar).

The provided query name and values will be encoded.

Specified by:

queryParam in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

name - the query parameter name

values - the query parameter values

Returns:

this UriComponentsBuilder

queryParams

public MockServerHttpRequest.BodyBuilder queryParams(MultiValueMap<java.lang.String,java.lang.String> params)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Add the given query parameters and values. The provided query name and corresponding values will be encoded.

Specified by:

queryParams in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

params - the params

Returns:

this UriComponentsBuilder

remoteAddress

public MockServerHttpRequest.BodyBuilder remoteAddress(java.net.InetSocketAddress remoteAddress)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the remote address to return.

Specified by:

remoteAddress in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

sslInfo

public void sslInfo(SslInfo sslInfo)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set SSL session information and certificates.

Specified by:

sslInfo in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

cookie

public MockServerHttpRequest.BodyBuilder cookie(HttpCookie... cookies)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Add one or more cookies.

Specified by:

cookie in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

cookies

public MockServerHttpRequest.BodyBuilder cookies(MultiValueMap<java.lang.String,HttpCookie> cookies)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Add the given cookies.

Specified by:

cookies in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

cookies - the cookies.

header

public MockServerHttpRequest.BodyBuilder header(java.lang.String headerName,
                                                java.lang.String... headerValues)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Add the given, single header value under the given name.

Specified by:

header in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

headerName - the header name

headerValues - the header value(s)

See Also:

HttpHeaders.add(String, String)

headers

public MockServerHttpRequest.BodyBuilder headers(MultiValueMap<java.lang.String,java.lang.String> headers)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Add the given header values.

Specified by:

headers in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

headers - the header values

accept

public MockServerHttpRequest.BodyBuilder accept(MediaType... acceptableMediaTypes)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the list of acceptable media types, as specified by the Accept header.

Specified by:

accept in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

acceptableMediaTypes - the acceptable media types

acceptCharset

public MockServerHttpRequest.BodyBuilder acceptCharset(java.nio.charset.Charset... acceptableCharsets)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the list of acceptable charsets, as specified by the Accept-Charset header.

Specified by:

acceptCharset in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

acceptableCharsets - the acceptable charsets

acceptLanguageAsLocales

public MockServerHttpRequest.BodyBuilder acceptLanguageAsLocales(java.util.Locale... acceptableLocales)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the list of acceptable locales, as specified by the Accept-Languages header.

Specified by:

acceptLanguageAsLocales in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

acceptableLocales - the acceptable locales

contentLength

public MockServerHttpRequest.BodyBuilder contentLength(long contentLength)

Description copied from interface: MockServerHttpRequest.BodyBuilder

Set the length of the body in bytes, as specified by the Content-Length header.

Specified by:

contentLength in interface MockServerHttpRequest.BodyBuilder

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

public MockServerHttpRequest.BodyBuilder contentType(MediaType contentType)

Description copied from interface: MockServerHttpRequest.BodyBuilder

Set the media type of the body, as specified by the Content-Type header.

Specified by:

contentType in interface MockServerHttpRequest.BodyBuilder

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

ifModifiedSince

public MockServerHttpRequest.BodyBuilder ifModifiedSince(long ifModifiedSince)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

Specified by:

ifModifiedSince in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

ifModifiedSince - the new value of the header

ifUnmodifiedSince

public MockServerHttpRequest.BodyBuilder ifUnmodifiedSince(long ifUnmodifiedSince)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the (new) value of the If-Unmodified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

Specified by:

ifUnmodifiedSince in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

ifUnmodifiedSince - the new value of the header

See Also:

HttpHeaders.setIfUnmodifiedSince(long)

ifNoneMatch

public MockServerHttpRequest.BodyBuilder ifNoneMatch(java.lang.String... ifNoneMatches)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the values of the If-None-Match header.

Specified by:

ifNoneMatch in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

ifNoneMatches - the new value of the header

range

public MockServerHttpRequest.BodyBuilder range(HttpRange... ranges)

Description copied from interface: MockServerHttpRequest.BaseBuilder

Set the (new) value of the Range header.

Specified by:

range in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Parameters:

ranges - the HTTP ranges

See Also:

HttpHeaders.setRange(List)

build

public MockServerHttpRequest build()

Description copied from interface: MockServerHttpRequest.BaseBuilder

Builds the request with no body.

Specified by:

build in interface MockServerHttpRequest.BaseBuilder<MockServerHttpRequest.BodyBuilder>

Returns:

the request

See Also:

BodyBuilder#body(Publisher), BodyBuilder#body(String)

body

public MockServerHttpRequest body(java.lang.String body)

Description copied from interface: MockServerHttpRequest.BodyBuilder

Set the body of the request and build it.

Specified by:

body in interface MockServerHttpRequest.BodyBuilder

Parameters:

body - the body

Returns:

the built request entity

getCharset

private java.nio.charset.Charset getCharset()

body

public MockServerHttpRequest body(<any> body)

Description copied from interface: MockServerHttpRequest.BodyBuilder

Set the body of the request and build it.

Specified by:

body in interface MockServerHttpRequest.BodyBuilder

Parameters:

body - the body

Returns:

the built request entity

applyCookiesIfNecessary

private void applyCookiesIfNecessary()

getUrlToUse

private java.net.URI getUrlToUse()